added RELEASE.md and CONTRIBUTING.md files#420
Merged
Conversation
msluszniak
reviewed
Jun 26, 2025
mkopcins
force-pushed
the
@mkopcins/repo-upkeep
branch
from
de93392 to
f0a213e
Compare
pweglik
reviewed
Jun 26, 2025
pweglik
reviewed
Jun 30, 2025
pweglik
reviewed
Jun 30, 2025
pweglik
reviewed
Jun 30, 2025
mkopcins
force-pushed
the
@mkopcins/repo-upkeep
branch
from
b426521 to
1b91fc8
Compare
pweglik
approved these changes
Jun 30, 2025
Contributor
pweglik
left a comment
pweglik
left a comment
There was a problem hiding this comment.
LGTM, but it's important piece of docs - force one more person to read through it
Member
|
Two additions from my side to
And there is a typo in PR title: |
chmjkb
reviewed
Jun 30, 2025
Comment on lines
+21
to
+34
| ## Feature request | ||
|
|
||
| Have an idea or is there a feature you would like to see added? Feel free to create a PR from a fork 😉. Alternatively if you don't have time for that just create a `🚀 Feature request` issue and fill in the necessary information. | ||
| The most important things to include are: | ||
|
|
||
| 1. What is the motivation behind it? Is it something that is missing but is present in another library? Or maybe you need something more specific for your use case? Or just an idea that popped into your head? | ||
| We'd love to hear about this! | ||
|
|
||
| 2. Describe it - add as much detail as you can. This helps to avoid any miscommunication problems and helps us to better understand it. | ||
|
|
||
| 3. Provide a code snippet with the example usage (optional). | ||
|
|
||
| 4. If there is a similar feature somewhere else drop a link (optional). | ||
|
|
Collaborator
There was a problem hiding this comment.
Maybe we should also mention here that it is not restricted to features but also new model support to kind of let people know that we'd like to see what they need in terms of model coverage, but feel free to ignore though
Collaborator
Author
There was a problem hiding this comment.
I thought this is somewhat contained in the ways-to-contribute/Export-new-models-to-ET-format section, but I can write it here explicitely
Comment on lines
+46
to
+47
| If you found some inconsistencies in our documentation or just something is missing just open a PR with suggested changes (remember to add changes to previous docs versions too). | ||
|
|
Collaborator
There was a problem hiding this comment.
remember to add changes to previous docs versions too). I'm not sure if this will be understandable for someone who doesn't know this codebase
Contributor
There was a problem hiding this comment.
We may change it to
Suggested change
| If you found some inconsistencies in our documentation or just something is missing just open a PR with suggested changes (remember to add changes to previous docs versions too). | |
| If you found some inconsistencies in our documentation or just something is missing just open a PR with suggested changes (remember to add changes to previous docs versions, in `versioned_docs` directory, too). | |
| 4. Commit with a message 'Release v{MAJOR}.{MINOR}.0'. (We want to keep the latest `MINOR` version on the `main` branch.) | ||
| 5. Create a new branch release branch `release/{MAJOR}.{MINOR}`and push it to the remote. | ||
| 6. Stability tests are performed on the release branch and all fixes to the new-found issues are pushed into the main branch and cherry-picked into the release branch. This allows for further development on the main branch without interfering with the release process. | ||
| 7. Once all tests are passed, tag the release branch with proper version tag `v{MAJOR}.{MINOR}.0` and run `npm publish`. |
Collaborator
There was a problem hiding this comment.
I think this is confusing, what tests are you referring to?
Collaborator
Author
There was a problem hiding this comment.
Since we don't have any automated tests right now and the only testing we do is test apps before release that's what I mean. In the future we should for sure add testing to the pipeline, at least for releases and maybe in the PRs. Also this is only for our internal use really
mkopcins
changed the title
added 2 commits
June 30, 2025 14:46
mkopcins
added a commit
that referenced
this pull request
Oct 15, 2025
## Description Add RELEASE.md na CONTRIBUTING.md files. ### Type of change - [ ] Bug fix (non-breaking change which fixes an issue) - [ ] New feature (non-breaking change which adds functionality) - [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected) - [x] Documentation update (improves or adds clarity to existing documentation) ### Tested on - [ ] iOS - [ ] Android ### Testing instructions <!-- Provide step-by-step instructions on how to test your changes. Include setup details if necessary. --> ### Screenshots <!-- Add screenshots here, if applicable --> ### Related issues <!-- Link related issues here using #issue-number --> ### Checklist - [ ] I have performed a self-review of my code - [ ] I have commented my code, particularly in hard-to-understand areas - [ ] I have updated the documentation accordingly - [ ] My changes generate no new warnings ### Additional notes <!-- Include any additional information, assumptions, or context that reviewers might need to understand this PR. --> --------- Co-authored-by: Mateusz Kopciński <mateusz.kopcinski@swmansnion.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
5 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
Add RELEASE.md na CONTRIBUTING.md files.
Type of change
Tested on
Testing instructions
Screenshots
Related issues
Checklist
Additional notes